IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/il/ilHwConnection.z/ilHwConnection

Text File | 2002-10-03 | 19.3 KB | 529 lines

iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



NNNNAAAAMMMMEEEE
     iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn - X server connection

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <il/ilHwConnection.h>


CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     ilHwConnection manages IL's private server connections, it is essentially
     a cache of shadow connections (to avoid redundant Display's) and also
     maintains a list of OpenGL contexts that have been created on each
     connection.

     The ilHwConnection also provides information on each display's
     capabilities (including whether or not OpenGL is supported and what
     operations are really done in hardware).

     Provision is also made for creation and caching of X colormaps for use
     with various visuals on each connection.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     AAAAllllllllooooccccaaaattttiiiioooonnnn aaaannnndddd ffffrrrreeeeeeeeiiiinnnngggg

          static ilHwConnection* alloc(Display* dpy=NULL)
          static ilHwConnection* getLocal()
          void free()

     GGGGeeeetttt////sssseeeetttt mmmmeeeetttthhhhooooddddssss

          int getID()
          Display* getDisplay()
          void getScreenSize(iflXYint& size)
          int getCapability()
          int hasCapability(int cap)
          int getExtension()
          int hasExtension(int ext)
          int getSupportedTypes()
          int getSupportedOrders()
          int supportsType(iflDataType type)
          int supportsOrder(iflOrder order)
          int isDirect()
          Colormap getDefaultColormap(VisualID id)
          ilFrameBufferImg* getDummyFbImg()
          int findVisualByAttr(ilHwVisual& vis, int attr=0, int minSize=1,
                               int maxSize = 0)
          int findVisualByID(ilHwVisual& vis, VisualID visualid)
          ilHwRenderer getRenderer()
          int getConvolveMaxWidth()
          int getConvolveMaxHeight()



                                                                        PPPPaaaaggggeeee 1111






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



          int getSepConvolveMaxWidth()
          int getSepConvolveMaxHeight()
          int getLutMaxSize()
          int getFilter4Size()
          void getTexCapacity(ilHwTexCapacity& capacity, GLenum target,
                              GLenum fmt, GLenum resamp)
          void setRenderingStyle(ilRenderingStyle style)
          ilRenderingStyle getRenderingStyle()



FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     aaaalllllllloooocccc(((())))

          static ilHwConnection* alloc(Display* dpy=NULL)


          The static method looks up (and possibly allocates) an
          ilHwConnection that matches the Display* given by _d_p_y.  It
          increments a reference count that will be decremented by the ffffrrrreeeeeeee()
          method.

     ffffiiiinnnnddddCCCCoooonnnntttteeeexxxxtttt(((())))

          ilHwContext* findContext(VisualID id)


          This method locates an ilHwContext that will work with the VisualID
          indicated by _i_d.

     ffffiiiinnnnddddVVVViiiissssuuuuaaaallllBBBByyyyAAAAttttttttrrrr(((())))

          int findVisualByAttr(ilHwVisual& vis, int attr=0, int minSize=1,
                               int maxSize = 0)


          This method fills in an ilHwVisual, _v_i_s, based on attributes
          specified in _a_t_t_r (see the enumerated type ilHwVisualAttributes in
          <il/ilHwConnection.h>), _m_i_n_S_i_z_e (minimum component size) and _m_a_x_S_i_z_e
          (maximum component size).

          The double-buffer, stereo and rgb attributes are just suggestions,
          not absolute requirments, if no visual is found with those
          attributes a lesser visual will be returned. The remaining
          attributes imply absolute requirements, no lesser visual will be
          returned.  The visual class fields restrict which visual classes
          will be considered, and are also absolute requirements.

     ffffiiiinnnnddddVVVViiiissssuuuuaaaallllBBBByyyyIIIIDDDD(((())))






                                                                        PPPPaaaaggggeeee 2222






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



          int findVisualByID(ilHwVisual& vis, VisualID visualid)


          This method fills in an ilHwVisual, _v_i_s, that matches the VisualID
          indicated by _v_i_s_u_a_l_i_d.

     ffffrrrreeeeeeee(((())))

          void free()


          The method decrements the reference count on this ilHwConnection.
          After calling this method the connection should be considered
          destroyed (although it will be cached if there are still active
          references).

     ggggeeeettttCCCCaaaappppaaaabbbbiiiilllliiiittttyyyy(((())))

          int getCapability()


          This methods returns the rendering capabilities of this connection
          as defined by ilHwCapability in <il/ilHwConnection.h>.

     ggggeeeettttCCCCoooonnnnvvvvoooollllvvvveeeeMMMMaaaaxxxxHHHHeeeeiiiigggghhhhtttt(((())))

          int getConvolveMaxHeight()


          If the server supports the OpenGL convolution extension, then this
          method returns the maximum height of a general convolution kernel.
          Otherwise, the method returns zero.

     ggggeeeettttCCCCoooonnnnvvvvoooollllvvvveeeeMMMMaaaaxxxxWWWWiiiiddddtttthhhh(((())))

          int getConvolveMaxWidth()


          If the server supports the OpenGL convolution extension, then this
          method returns the maximum width of a general convolution kernel.
          Otherwise, the method returns zero.

     ggggeeeettttDDDDeeeeffffaaaauuuullllttttCCCCoooolllloooorrrrmmmmaaaapppp(((())))

          Colormap getDefaultColormap(VisualID id)


          This method returns a colormap suitable for use with the visual
          indicated by _i_d.  The colormaps thus allocated are cached on this
          connection.





                                                                        PPPPaaaaggggeeee 3333






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



     ggggeeeettttDDDDiiiissssppppllllaaaayyyy(((())))

          Display* getDisplay()


          Returns the internal Display* for this connection;

     ggggeeeettttDDDDuuuummmmmmmmyyyyFFFFbbbbIIIImmmmgggg(((())))

          ilFrameBufferImg* getDummyFbImg()


          The IL maintains a dummy window that is used to perform accelerated
          statistics operations when no images are being displayed.  The
          window is unmapped and zero-sized.  This method returns the
          ilFrameBufferImg associated with this window.

     ggggeeeettttEEEExxxxtttteeeennnnssssiiiioooonnnn(((())))

          int getExtension()


          Query the OpenGL extensions supported by this connection.  The
          extensions are encoded in a bit mask.  The bits are defined in the
          ilHwExtension enum in <il/ilHwConnection.h>.

     ggggeeeettttFFFFiiiilllltttteeeerrrr4444SSSSiiiizzzzeeee(((())))

          int getFilter4Size()


          This method returns the size of the bicubic resampling filter
          expected by this connection.  (This value has meaning only if the
          server supports the OpenGL "filter4" extension.)

     ggggeeeettttIIIIDDDD(((())))

          int getID()


          This method returns an unique internal ID for this connection.  This
          is not intended for external use.

     ggggeeeettttLLLLooooccccaaaallll(((())))

          static ilHwConnection* getLocal()


          This static method is a specialized version of the aaaalllllllloooocccc() method
          that returns a connection to the local server (useful for
          accelerated operations that will not be directly displayed).




                                                                        PPPPaaaaggggeeee 4444






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



     ggggeeeettttLLLLuuuuttttMMMMaaaaxxxxSSSSiiiizzzzeeee(((())))

          int getLutMaxSize()


          This method returns the maximum size of a color table accepted by
          this connection.

     ggggeeeettttRRRReeeennnnddddeeeerrrreeeerrrr(((())))

          ilHwRenderer getRenderer()


          Returns the type of graphics device associated with this connection.
          The result can be one of the following enums:

          enum ilHwRenderer {
              ilHwRendIR,             // InfiniteReality
              ilHwRendRE,             // RealityEngine
              ilHwRendImpact,         // Impact
              ilHwRendNewport,        // Newport Graphics (Indy/Indigo2)
              ilHwRendIndigo,         // Indigo Entry, Indy[XL], XS, XZ, Elan, Extreme
              ilHwRendCrime,          // O2
              ilHwRendOther           // Unknown
          };


     ggggeeeettttRRRReeeennnnddddeeeerrrriiiinnnnggggSSSSttttyyyylllleeee(((())))

          ilRenderingStyle getRenderingStyle()


          Returns the default rendering style of either _i_l_O_p_e_n_G_L_R_e_n_d_e_r_i_n_g
          (default if OpenGL available) or _i_l_X_R_e_n_d_e_r_i_n_g for this connection.

     ggggeeeettttSSSSccccrrrreeeeeeeennnnSSSSiiiizzzzeeee(((())))

          void getScreenSize(iflXYint& size)


          Returns the screen resolution (in pixels).

     ggggeeeettttSSSSeeeeppppCCCCoooonnnnvvvvoooollllvvvveeeeMMMMaaaaxxxxHHHHeeeeiiiigggghhhhtttt(((())))

          int getSepConvolveMaxHeight()


          If the server supports the OpenGL convolution extension, then this
          method returns the maximum height of a seperable convolution kernel.
          Otherwise, the method returns zero.





                                                                        PPPPaaaaggggeeee 5555






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



     ggggeeeettttSSSSeeeeppppCCCCoooonnnnvvvvoooollllvvvveeeeMMMMaaaaxxxxWWWWiiiiddddtttthhhh(((())))

          int getSepConvolveMaxWidth()


          If the server supports the OpenGL convolution extension, then this
          method returns the maximum width of a seperable convolution kernel.
          Otherwise, the method returns zero.

     ggggeeeettttSSSSuuuuppppppppoooorrrrtttteeeeddddOOOOrrrrddddeeeerrrrssss(((())))

          int getSupportedOrders()


          This method returns a logical OR of the supported dimension orders
          (as defined by iflOrder) that OpenGL transfers on this connection
          can use.

     ggggeeeettttSSSSuuuuppppppppoooorrrrtttteeeeddddTTTTyyyyppppeeeessss(((())))

          int getSupportedTypes()


          This method returns a logical OR of the supported data types (as
          defined by iflDataType) that OpenGL transfers on this connection can
          use.

     ggggeeeettttTTTTeeeexxxxCCCCaaaappppaaaacccciiiittttyyyy(((())))

          void getTexCapacity(ilHwTexCapacity& capacity, GLenum target,
                              GLenum fmt, GLenum resamp)


          This method returns the texture capacity of the server.  The result
          is a function of the texture target, format and resampling type.
          Currently, the target can be only _G_L__T_E_X_T_U_R_E__2_D.  The result is
          returned in the ilHwTexCapacity class:

          class ilHwTexCapacity {
          public:
              ilHwTexCapacity() : limit(0, 0, 0) { texels = 0; }

              iflXYZint limit; // log_2 of the maximum texture size in each dimension
              int texels;      // the maximum area (volume) of a texture
              int units;       // the number of allocation units (banks)
          };









                                                                        PPPPaaaaggggeeee 6666






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



     hhhhaaaassssCCCCaaaappppaaaabbbbiiiilllliiiittttyyyy(((())))

          int hasCapability(int cap)


          This methods tests for the presence of certain rendering
          capabilities, specified by _c_a_p, on this connection.  The possible
          values are defined by ilHwCapability in <il/ilHwConnection.h>.

     hhhhaaaassssEEEExxxxtttteeeennnnssssiiiioooonnnn(((())))

          int hasExtension(int ext)


          Queries the connection for a particular extension by testing the bit
          fields returned by ggggeeeettttEEEExxxxtttteeeennnnssssiiiioooonnnn().  See ggggeeeettttEEEExxxxtttteeeennnnssssiiiioooonnnn().

     iiiissssDDDDiiiirrrreeeecccctttt(((())))

          int isDirect()


          Returns TRUE if this connection supports direct OpenGL contexts.

     sssseeeettttRRRReeeennnnddddeeeerrrriiiinnnnggggSSSSttttyyyylllleeee(((())))

          void setRenderingStyle(ilRenderingStyle style)


          Sets the default rendering style to either _i_l_O_p_e_n_G_L_R_e_n_d_e_r_i_n_g or
          _i_l_X_R_e_n_d_e_r_i_n_g for this connection.

     ssssuuuuppppppppoooorrrrttttssssOOOOrrrrddddeeeerrrr(((())))

          int supportsOrder(iflOrder order)


          This method returns true if the specified dimension order, _o_r_d_e_r,
          (as defined by iflOrder) is supported for OpenGL transfers on this
          connection.

     ssssuuuuppppppppoooorrrrttttssssTTTTyyyyppppeeee(((())))

          int supportsType(iflDataType type)


          This method returns true if the specified data type, _t_y_p_e, (as
          defined by iflDataType) is supported for OpenGL transfers on this
          connection.






                                                                        PPPPaaaaggggeeee 7777






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



SSSSEEEEEEEE AAAALLLLSSSSOOOO
     ilHwContext(3), ilHwVisual(3), <il/ilHwConnection.h>





















































                                                                        PPPPaaaaggggeeee 8888